﻿/*
 *  Copyright (C) 2010 by Benjamin Nolmans <benjamin.nolmans@gmail.com>
 *  and Barbara Post <postb99@gmail.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

using OsamesFrameworkCore.Plugins.Configuration;

namespace OsamesFrameworkCore.Plugins.Management.Types
{
    /// <summary>
    /// Data Class for Available Plugin.  Holds and instance of the loaded Plugin.
    /// </summary>
    public class AvailablePlugin
    {
        /// <summary>
        /// Reference to plugin class by its highest level interface.
        /// </summary>
        public IPlugin Plugin { get; set; }

        /// <summary>
        /// Location of plugin assembly, not its shadow copy.
        /// </summary>
        public string PluginLocation { get; set; }

        /// <summary>
        /// Returns Plugin if it implements IWebPlugin, else null.
        /// </summary>
        public IWebPlugin WebPlugin
        {
            get
            {
                if (Plugin is IWebPlugin)
                    return Plugin as IWebPlugin;
                return null;
            }
        }
        /// <summary>
        /// Constructor.
        /// </summary>
        public AvailablePlugin()
        {
            Plugin = null;
            PluginLocation = string.Empty;
        }
        /// <summary>
        /// Checks that configuration file loads correctly.
        /// </summary>
        public void LoadPluginConfig()
        {
            Plugin.XmlDictPluginConfiguration = PluginConfigurationManager.Load(this);           
        }
    }
}
